ParcelLabel API

2.0.x
(2 reviews)

Download Label(s) Direct

Resource URL

UAT:

Download all labels generated within a consignment:

https://api.uat.nzpost.co.nz/ParcelLabel/v3/labels/{consignment_id}/direct?client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

Production:

Download all labels generated within a consignment:

https://api.nzpost.co.nz/ParcelLabel/v3/labels/{consignment_id}/direct?client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

Resource Description

Returns all labels images as a PDF within a consignment. Unlike resource /labels/{consignment_id}, resource /labels/{consignment_id}/direct only supports PDF format which is set by default. As this resource only supports PDF and not PNG, we do not pass parameters page and base64 as these parameters are only relevant to PNG format. Labels are only available for download of a consignment with status "Complete". Use Get Status of Labels resource to check the status of the consignment prior to download.

Resource Information

AttributeDetail
Response FormatPDF
Requires AuthenticationYes
Rate Limited15 calls per second. If rate limit is exceeded, calls will be queued. Calls unprocessed for over 60 seconds will time out.

Request Parameters

Field NameDescriptionMandExample
consignment_idThe unique id of a consignmentYes7EDZHE
client_idThe client id associated consuming applicationYesYOUR_CLIENT_ID
client_secretThe client secret of the consuming applicationYesYOUR_CLIENT_SECRET
user_nameThe user nameNouser@example.co.nz

Sample Requests

Download all labels generated within a consignment:

https://api.uat.nzpost.co.nz/ParcelLabel/v3/labels/LLT2BL/direct?clent_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

Download all labels generated within a consignment with user_name parameter:

https://api.uat.nzpost.co.nz/ParcelLabel/v3/labels/LLT2BL/direct?client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&user_name=donald

Response

A PDF containing the label image(s) is returned.

Reviews